Primitive Class Flow.Horizon
Represents a horizon.
Functions
| Horizon(objectID) | Create a horizon object. |
| GetEnabled() | Get the horizon's enabled state. |
| GetObjectID() | Get the horizon's slot object ID. |
| GetPosition() | Get the horizon's world position. |
| GetRotation() | Get the horizon's rotation. |
| GetTransparency() | Get the horizon's transparency. |
| SetEnabled(enabled) | Set the horizon's enabled state. |
| SetObjectID(objectID) | Set the horizon's object ID. |
| SetPosition(pos[, noInterpolation]) | Set the horizon's world position. |
| SetRotation(rot[, noInterpolation]) | Set the horizon's rotation. |
| SetTransparency(transparency) | Set the horizon's transparency. |
Functions
- Horizon(objectID)
-
Create a horizon object.
Parameters:
- objectID ObjID Object ID for the horizon to use.
Returns:
-
Horizon
A new Horizon object.
- GetEnabled()
-
Get the horizon's enabled state.
Returns:
-
bool
Enabled state.
- GetObjectID()
-
Get the horizon's slot object ID.
Returns:
-
ObjID
Object ID.
- GetPosition()
-
Get the horizon's world position.
Returns:
-
Vec3
Position.
- GetRotation()
-
Get the horizon's rotation.
Returns:
-
Rotation
Rotation.
- GetTransparency()
-
Get the horizon's transparency.
Returns:
-
float
Transparency.
- SetEnabled(enabled)
-
Set the horizon's enabled state.
Parameters:
- enabled bool New enabled state.
- SetObjectID(objectID)
-
Set the horizon's object ID.
Parameters:
- objectID ObjID Object ID.
- SetPosition(pos[, noInterpolation])
-
Set the horizon's world position.
Parameters:
- pos Vec3 New world position.
- noInterpolation bool Disable interpolation with the previous frame's position. default: false (optional)
- SetRotation(rot[, noInterpolation])
-
Set the horizon's rotation.
Parameters:
- rot Rotation New rotation.
- noInterpolation bool Disable interpolation with the previous frame's rotation. default: false (optional)
- SetTransparency(transparency)
-
Set the horizon's transparency.
Parameters:
- transparency float New transparency alpha.